Skip to content

docs: Improve Anti-Corruption-Layer README(#3200) #3206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 18, 2025
Merged

docs: Improve Anti-Corruption-Layer README(#3200) #3206

merged 1 commit into from
Mar 18, 2025

Conversation

@Duartegdm
Copy link
Contributor

@Duartegdm Duartegdm commented Mar 14, 2025

Pull Request Template

What does this PR do?

This PR improves the documentation of the pattern "anti-corruption-layer".

On this PR, I changed the attribute orderInModernSystem type from Optional to Optional. Improving the usage example on README.MD.

@github-actions
Copy link

github-actions bot commented Mar 14, 2025 •
edited
Loading

PR Summary

Improved the documentation of the anti-corruption-layer pattern by changing the orderInModernSystem attribute type from Optional<LegacyOrder> to Optional<ModernOrder> and enhancing the usage example in the README.md file.

Changes

File Summary
anti-corruption-layer/README.md Updated the example in the anti-corruption-layer documentation by changing the type of the orderInModernSystem variable from Optional<LegacyOrder> to Optional<ModernOrder>. This change improves the clarity and accuracy of the example.

autogenerated by presubmit.ai

github-actions[bot]
github-actions bot reviewed Mar 14, 2025
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚨 Pull request needs attention.

Review Summary

Commits Considered (1)
  • 3f65efd: docs: Improve Anti-Corruption-Layer README(#3200)
Files Processed (1)
  • anti-corruption-layer/README.md (1 hunk)
Actionable Comments (1)
  • anti-corruption-layer/README.md [125-125]

    possible issue: "Type Change in orderInModernSystem"

Skipped Comments (0)

anti-corruption-layer/README.md
String id = legacyOrder.getId();

Optional<LegacyOrder> orderInModernSystem = acl.findOrderInModernSystem(id);
Optional<ModernOrder> orderInModernSystem = acl.findOrderInModernSystem(id);
Copy link

@github-actions github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type of orderInModernSystem has changed from Optional<LegacyOrder> to Optional<ModernOrder>. Ensure this change is consistent with the overall design and doesn't introduce unexpected behavior or break existing functionality.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 14, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@iluwatar iluwatar merged commit a89cf98 into iluwatar:master Mar 18, 2025
2 checks passed
@iluwatar
Copy link
Owner

iluwatar commented Mar 18, 2025

Looks good! Thank you for the contribution 🎉

@all-contributors please add @Duartegdm for docs

@allcontributors allcontributors bot mentioned this pull request Mar 18, 2025
Merged
@allcontributors
Copy link
Contributor

allcontributors bot commented Mar 18, 2025

@iluwatar

I've put up a pull request to add @Duartegdm! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@iluwatar iluwatar iluwatar approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Duartegdm @iluwatar